Skip to main content
Version: 5.4

Configuration Service

AttendanceSettingsDto

This class contains information about the attendance list settings.

DatatypeNameDescription
boolShowStaffOnlyInCoverageFlag indicating whether the attendance list shows all staff, or only staff that is in coverage
boolFinishWorkByManuallyBookingFlag indicating whether the end of work shall be retrieved by manually booking

AutomatedMailsDto

This class contains information about the automatic mail dispatch in TimePunch.

DatatypeNameDescription
MailReceiverMailCoreTimeViolationDefines to whom the core time violations shall be send
StringMailCoreTimeViolationToCustomMailAddressDefines a custom mail address to whom the core time violations shall be send. It’s possible to define multiple addresses separated by comma.
MailReceiverMailMonthEndClosingDefines to whom the month end closings shall be send
StringMailMonthEndClosingCustomMailAddressDefines a custom mail address to whom the month end closings shall be send. It’s possible to define multiple addresses separated by comma.
MailReceiverMailTimeEntryAuditDefines to whom time entry audits shall be send
StringMailTimeEntryAuditToCustomMailAddressDefines a custom mail address to whom the time entry audits shall be send. It’s possible to define multiple addresses separated by comma.
MailReceiverMailFireAndHireDefines to whom fire and hire information shall be send
StringMailFireAndHireToCustomMailAddressDefines a custom mail address to whom the fire and hire information shall be send. It’s possible to define multiple addresses separated by comma.
MailReceiverMailFinishedWorkDefines to whom the finished work information shall be send
StringMailFinishedWorkCustomMailAddressDefines a custom mail address to whom the finished work information shall be send. It’s possible to define multiple addresses separated by comma.

CalculationInternalsDto

Diese Klasse beinhaltet Einstellungen zur internen Berechnungslogik von TimePunch.

DatatypeNameDescription
ContinuedPaymentLeavePayoutCalculationDefines how the continued leave payout will be calculated (AsWorkTime, AsAveragePayout)
ContinuedPaymentSickPayoutCalculationDefines how the continued sick payout will be calculated (AsWorkTime, AsAveragePayout)
ContinuedPaymentBankHolidayPayoutCalculationDefines how the continued bank holiday payout will be calculated (AsWorkTime, AsAveragePayout)
BoolIsDataPreviewDefines, if a data preview shall be activated. With activated data preview, the times will be calculated ahead for the current month.
DateTime?OverbookingIsAllowedSinceDefines, if overbooking is allowed and since when it is allowed.
double?OvertimeSurchargeStartDefines the start of the overtime surcharge. If not defined the surcharge time starts with the target time of the user.
ShortTimeWorkShortTimeWorkDefines how short time work shall be handled (PerDay, PerMonth)
OvernightEntriesOvernightEntriesDefines how overnight entries shall be displayed to the user (Split, Merge)
boolIsDayPartRoundedFlag that defines whether the day part calculation gets rounded

CostCenterDto

This class contains information about the cost center assignment of the different booking types in TimePunch.

DatatypeNameDescription
StringSicknessCostcenterCost center that is used for sickness bookings
StringLeaveCostcenterCost center that is used for leave bookings
StringOfficialBankHolidayCostcenterCost center that is used for official bank holiday bookings
StringSpecialLeaveCostCenterCost center that is used for special leave bookings
StringCorrectionCostCenterCost center that is used for overtime/flexitime corrections

SalaryExportDto

This class contains information about the settings for wage data export.

DatatypeNameDescription
StringFixedSalaryTypeNoDefines the account for the fixed salary export.
StringTemporaryHourlyWageTypeNoDefines the account for the temporary hourly wage workers.
StringHourlyWageTypeNoDefines the account for the hourly wage workers.
StringSicknessTypeNoDefines the account for the time of sickness.
StringLeaveTypeNoDefines the account for the leave time.
StringSpecialLeaveTypeNoDefines the account for the special leave time.
StringPaidOvertimeTypeNoDefines the account for the paid overtime.
StringOfficialBankHolidayTypeNoDefines the account for the official bank holiday.
StringPaidOfficialBankHolidayTypeNoDefines the account forfor the paid official bank holiday work time
StringSaturdayWorkAmTypeNoDefines the account for the work at Saturday morning.
StringSaturdayWorkPmTypeNoDefines the account for the work at Saturday afternoon.
TimeSpanSaturdaySplitTimeTime that separates the saturday morning of the saturday afternoon.
StringSundayWorkTypeNoDefines the account for the worktime at Sunday.
StringNightShiftTypeNoDefines the account for the night shift working time.
StringNightShiftCoreTypeNoDefines the account for the night shift core working time.
TimeSpanNightShiftStartTimeStart time of the night shift
TimeSpanNightShiftEndTime1End time of the core night shift.
TimeSpanNightShiftEndTime2End time of the extended night shift.
StringOvertimeTypeNoDefines the account for the overtime
StringOnCallServiceTypeNoDefines the account for the on-call service
StringShortTimeWorkTypeNoDefines the account for the short time work.
StringSicknessNotPaidTypeNoDefines the account for the sick days that are not paid
stringMorningShiftTypeNoDefines the account for the morning shift time
TimeSpanMorningShiftStartTimeDefines the start time for the morning shift
TimeSpanEveningShiftEndTimeDefines the end time for the morning shift
stringEveningShiftTypeNoDefines the account for the evening shift time
TimeSpanEveningShiftStartTimeDefines the start time for the evening shift
TimeSpanEveningShiftEndTimeDefines the end time for the evening shift

GlobalSalaryExportDto: SalaryExportDto

This class contains information about the global settings for export to a connected payroll accounting system.

DatatypeNameDescription
SalaryExportTargetExportTargetDefines to which system the data shall be exported (DatevLODAS, DatevLohnUndGehalt, LexwareLohnUndGehalt, SBSLohnPlus)
SalaryExportTypeExportTypeDefines the type of the salary export. SimplePayout The complete month gets exported SubsequentPayout Export in the middle of the month using DATEV retroactive billing FloatingPayout Export in the middle of the month without using the DATEV recalculation
StringStatisticLeaveAsDays TypeNoDefines the statistic type no for taken leave
StringStatisticSickAsDaysTypeNoDefines the statistic type no for sick days
StringStatisticRemainingLeave AsDaysTypeNoDefines the statistic type no for remaining leave days
StringStatisticWorkAccount TypeNoDefines the statistic type no for the working account
BoolStatisticLeaveAsDays TypeNoCheckedDefines, if the statistic value for leave as days shall be exported
BoolStatisticSickAsDays TypeNoCheckedDefines, if the statistic value for sick days shall be exported
BoolStatisticRemainingLeave AsDaysTypeNoCheckedDefines, if the statistic value for remaining leave as days shall be exported
BoolStatisticWorkAccountType NoCheckedDefines, if the statistic value for the working account shall be exported
BoolBookMissingButPaidWorkTimesToPaidOvertimeIf true, missing work time that gets paid, will be booked as paid overtime

UserSalaryExportDto: SalaryExportDto

This class contains information about the global settings for export to a connected payroll accounting system.

DatatypeNameDescription
GuidUserIdId of the user
TimeSpan?NightShiftStartTimeStart time of the night shift
TimeSpan?NightShiftEndTime1End time of the core night shift.
TimeSpan?NightShiftEndTime2End time of the extended night shift.
TimeSpan?SaturdaySplitTimeTime that separates the saturday morning of the saturday afternoon.
TimeSpan?MorningShiftStartTimeStart time of the morning shift.
TimeSpan?MorningShiftEndTimeEnd time of the morning shift.
TimeSpan?EveningShiftStartTimeStart time of the evening shift.
TimeSpan?EveningShiftEndTimeEnd time of the evening shift.

UserSettingsDto

This class contains settings for the behaviour of TimePunch.

DatatypeNameDescription
BoolIsAllowedToOverwriteBreaksFlag that indicates whether a break can be overwritten by user with restricted access. This value is false by default, because we do not want the user (without the managing permissions) to do that.
StringIsAllowedToManageProjectAccessFlat that indicates whether the timepunch user can manage project access. This value is true by default. It may only be false if the project access gets managed by a 3rd party software
BoolDisableCreationOfMasterdataDuringImportFlag that prevents the creation of master data during import, if master data is missing in import file.
ProjectAvailabilityProjectAvailabilityForNewProjectsThis field defines the default availability for new created projects.
FullNameModeFullNameModeThe full name mode defines the ordering of the employee names. e.g. 'firstname lastname' or 'lastname, firstname'

DocumentStoreConfigurationDto

This class contains the configuration of the document store in TimePunch.

DatatypeNameDescription
intMaxDatabaseSizeGBMaximum size of the document storage.
intMaxFileSizeMBMaximum file size of one PDF Document stored in the document storage.

VisualSettingsDto

This class contains the configuration of the UI settings.

DatatypeNameDescription
TimeEntryCheckboxTimeEntryCheckboxesDefines the visible checkboxes at the time entry dialog
boolDefaultShowAccountingDetailsTrue, if the project accounting details shall be visible to the user
boolDefaultIsDescriptionMandatoryTrue, if the describtion of a time entry field is mandatory

RetroactiveProjectAssignmentDto

This class contains the settings for the retroactive project assignment of the working time.

DatatypeNameDescription
GuidDefaultAccountingProjectIdThe default project id that is used for project accounting
intDaysForRetroactiveAssignmentThe amount of days for which is the retroactive accounting open for
int?RemindUserAfterDaysThe timespan in days after that the user gets a reminder
int?InformProjectLeadAfterDaysThe timespan in days after the team leader gets informed
intMinimumUnassignedTimeInMinutesThe minimum unassigned time in minutes
boolIsDefaultBreakProjectAllowedIf true, users are allowed to book break times for the retroactive accounting